Node / meshtastic / Meshtastic-Android / files / conductor / code_styleguides / general.md

Displaying Rendered • View raw • Download

This document outlines general coding principles that apply across all languages and frameworks used in this project.

• Code should be easy to read and understand by humans.

• Avoid overly clever or obscure constructs.

• Follow existing patterns in the codebase.

• Maintain consistent formatting, naming, and structure.

• Prefer simple solutions over complex ones.

• Break down complex problems into smaller, manageable parts.

• Write code that is easy to modify and extend.

• Minimize dependencies and coupling.

• Document why something is done, not just what.

• Keep documentation up-to-date with code changes.